GtkCellRendererToggle: correct "toggled" signal documentation
authorDan Williams <dcbw@redhat.com>
Thu, 10 Oct 2013 21:31:44 +0000 (16:31 -0500)
committerDan Williams <dcbw@redhat.com>
Thu, 10 Oct 2013 22:07:42 +0000 (17:07 -0500)
Previous commit wrongly identified "active" as containing the new
value.  Instead, applications must determine the new value to
update the model with manually based on the value currently in the
model.

gtk/gtkcellrenderertoggle.c

index 77174c87749ec4f8a54c48c984acd76bb6999962..b1d4d7b65c4af0427b9cdcf79d9639ecd7cb1160 100644 (file)
@@ -183,7 +183,8 @@ gtk_cell_renderer_toggle_class_init (GtkCellRendererToggleClass *class)
    * The ::toggled signal is emitted when the cell is toggled. 
    *
    * It is the responsibility of the application to update the model
-   * and store the "active" property at the position indicated by @path.
+   * with the correct value to store at @path.  Often this is simply the
+   * opposite of the value currently stored at @path.
    **/
   toggle_cell_signals[TOGGLED] =
     g_signal_new (I_("toggled"),